package com.zhengbing.tj.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Swagger配置类
 * 配置API文档生成相关信息
 *
 * @author zhengbing
 * @date 2025-08-01
 */
@Configuration
public class SwaggerConfig {

    /**
     * 创建API文档配置
     *
     * @return Docket对象
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                // 扫描指定包下的API
                .apis(RequestHandlerSelectors.basePackage("com.zhengbing.tj.controller"))
                // 扫描所有请求路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 设置API文档基本信息
     *
     * @return ApiInfo对象
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 文档标题
                .title("TJ项目API文档")
                // 文档描述
                .description("提供TJ项目的所有API接口文档")
                // 文档版本
                .version("1.0.0")
                // 联系人信息
                .contact(new Contact("zhengbing", "https://example.com", "mydreambing@126.com"))
                .build();
    }
}